docs: add user permission docs #2147
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Dennis Zhuang <[email protected]>
killme2008
requested review from
Copilot and
nicecui
and removed request for
fengjiachun and
nicecui
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for user permission management in GreptimeDB's static authentication, expanding beyond basic username/password configuration to include role-based access control.
Key changes:
- Adds permission mode configuration (readonly, writeonly, readwrite) with syntax examples
- Documents dynamic file reloading capability using
watch_file_user_provider - Provides detailed configuration examples with mixed permission scenarios
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/user-guide/deployments-administration/authentication/static.md | English documentation with permission modes, dynamic reloading, and comprehensive examples |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/authentication/static.md | Chinese translation of the same permission documentation updates |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Deploying greptime-docs with
|
| Latest commit: |
c0b14e3
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://4d7f39e7.greptime-docs.pages.dev |
| Branch Preview URL: | https://feature-static-user-permissi.greptime-docs.pages.dev |
nicecui
reviewed
Sep 25, 2025
...s-plugin-content-docs/current/user-guide/deployments-administration/authentication/static.md
Outdated
Show resolved
Hide resolved
...s-plugin-content-docs/current/user-guide/deployments-administration/authentication/static.md
Show resolved
Hide resolved
docs/user-guide/deployments-administration/authentication/static.md
Outdated
Show resolved
Hide resolved
...s-plugin-content-docs/current/user-guide/deployments-administration/authentication/static.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Dennis Zhuang <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
...s-plugin-content-docs/current/user-guide/deployments-administration/authentication/static.md
Outdated
Show resolved
Hide resolved
...s-plugin-content-docs/current/user-guide/deployments-administration/authentication/static.md
Show resolved
Hide resolved
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Signed-off-by: Dennis Zhuang <[email protected]>
Signed-off-by: Dennis Zhuang <[email protected]>
Signed-off-by: Dennis Zhuang <[email protected]>
nicecui
approved these changes
Sep 26, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What's Changed in this PR
Describe the change in this PR
Close #2144
The k8s cluster needs to support the permission mode too. cc @zyy17
Checklist
sidebars.tsmatches the current document structure when you changed the document structure.